Skip to content

Comments

chore: improve the error UI of link preview#7741

Closed
asjqkkkk wants to merge 3 commits intoAppFlowy-IO:mainfrom
asjqkkkk:fix/link_preview
Closed

chore: improve the error UI of link preview#7741
asjqkkkk wants to merge 3 commits intoAppFlowy-IO:mainfrom
asjqkkkk:fix/link_preview

Conversation

@asjqkkkk
Copy link
Collaborator

@asjqkkkk asjqkkkk commented Apr 14, 2025 •
edited by sourcery-ai bot
Loading

Before:

image

After:

image

Feature Preview

PR Checklist

  • My code adheres to AppFlowy's Conventions
  • I've listed at least one issue that this PR fixes in the description above.
  • I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
  • All existing tests are passing.

Summary by Sourcery

Improve the error and loading state UI for link previews, enhancing the visual presentation and handling of link preview information

Enhancements:

  • Refactor link preview widget to handle different loading and error states more elegantly
  • Improve fallback display of link information by using URL host when title is not available

Chores:

  • Simplify link preview widget logic for displaying loading, error, and content states

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 14, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request improves the error UI of the link preview by displaying the URL host when the title is null, adjusting the layout, and refactoring the loading and error widgets. It also adds a check for null imageUrl to prevent errors when building the image.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Improved the display of the link preview by showing the URL host when the title is null and adjusting the layout.
  • Display the URL host as the title if the actual title is null.
  • Adjusted the Column layout to use a Spacer when the description is null, improving vertical alignment.
  • Removed the error icon and logic, as the error state is now handled differently.
 frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/link_preview/custom_link_preview.dart
Added a check for null imageUrl to prevent errors when building the image.
  • Added a conditional check for imageUrl being null in the buildImage method, returning an empty SizedBox if it is null.
 frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/link_preview/custom_link_preview.dart
Refactored the loading and error widgets to only include a loading widget.
  • Removed the buildLoadingOrErrorWidget method.
  • Created a buildLoadingWidget method that only returns the circular progress indicator.
  • The error handling is now managed by the parent widget.
 frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/link_preview/custom_link_preview.dart
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Apr 14, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @asjqkkkk - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider extracting the hardcoded values like paddings and font sizes into named constants for better maintainability.
  • It might be good to have a dedicated error widget instead of just a loading indicator for error states.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@asjqkkkk asjqkkkk closed this Apr 17, 2025
@asjqkkkk asjqkkkk deleted the fix/link_preview branch April 17, 2025 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@asjqkkkk